sdk/samples/all in on code/Visual Studio 2008/CSFileMappingClient/ReadMe.txt

   1 ========================================================================
   2     CONSOLE APPLICATION : CSFileMappingClient Project Overview
   3 ========================================================================
   4
   5 /////////////////////////////////////////////////////////////////////////////
   6 Summary:
   7
   8 File mapping is a mechanism for one-way or duplex inter-process communication
   9 among two or more processes in the local machine. To share a file or memory,
  10 all of the processes must use the name or the handle of the same file mapping
  11 object.
  12
  13 To share a file, the first process creates or opens a file by using the
  14 CreateFile function. Next, it creates a file mapping object by using the
  15 CreateFileMapping function, specifying the file handle and a name for the
  16 file mapping object. The names of event, semaphore, mutex, waitable timer,
  17 job, and file mapping objects share the same name space. Therefore, the
  18 CreateFileMapping and OpenFileMapping functions fail if they specify a name
  19 that is in use by an object of another type.
  20
  21 To share memory that is not associated with a file, a process must use the
  22 CreateFileMapping function and specify INVALID_HANDLE_VALUE as the hFile
  23 parameter instead of an existing file handle. The corresponding file mapping
  24 object accesses memory backed by the system paging file. You must specify
  25 a size greater than zero when you use an hFile of INVALID_HANDLE_VALUE in a
  26 call to CreateFileMapping.
  27
  28 Processes that share files or memory must create file views by using the
  29 MapViewOfFile or MapViewOfFileEx function. They must coordinate their access
  30 using semaphores, mutexes, events, or some other mutual exclusion technique.
  31
  32 The VC# code sample demonstrates opening a file mapping object named
  33 "Local\SampleMap" and reading the string written to the file mapping by other
  34 process. Because the Base Class Library of .NET Framework 2/3/3.5 does not
  35 have any public classes to operate on file mapping objects, you have to
  36 P/Invoke the Windows APIs as shown in this code sample.
  37
  38
  39 /////////////////////////////////////////////////////////////////////////////
  40 Demo:
  41
  42 The following steps walk through a demonstration of the file mapping sample.
  43
  44 Step1. After you successfully build the CSFileMappingClient and
  45 CSFileMappingServer sample projects in Visual Studio 2008, you will get the
  46 applications: CSFileMappingClient.exe and CSFileMappingServer.exe.
  47
  48 Step2. Run CSFileMappingServer.exe in a command prompt. The application will
  49 create a file mapping object of a specified size that is backed by the system
  50 paging file. Its name is "Local\SampleMap".
  51
  52   The file mapping (Local\SampleMap) is created
  53
  54 Next, the application maps a view of the file mapping into the address space
  55 of the process, and writes a string to the view.
  56
  57   The file view is mapped
  58   This message is written to the view:
  59   "Message from the first process."
  60
  61 Step3. Run CSFileMappingClient.exe in another command prompt.
  62 CSFileMappingClient opens the file mapping object "Local\SampleMap", maps
  63 the same view of the file mapping into its address space, and read the string
  64 written by the first process from the view.
  65
  66   The file mapping (Local\SampleMap) is opened
  67   The file view is mapped
  68   Read from the file mapping:
  69   "Message from the first process."
  70
  71 Step4. Press ENTER in both command prompts to close CSFileMappingServer and
  72 CSFileMappingClient.
  73
  74
  75 /////////////////////////////////////////////////////////////////////////////
  76 Sample Relation:
  77 (The relationship between the current sample and the rest samples in
  78 Microsoft All-In-One Code Framework http://1code.codeplex.com)
  79
  80 CSFileMappingClient -> CSFileMappingServer
  81 CSFileMappingServer creates the file mapping named "Local\SampleMap" and
  82 writes a string to it. CSFileMappingClient reads the string from the file
  83 mapping.
  84
  85
  86 /////////////////////////////////////////////////////////////////////////////
  87 Code Logic:
  88
  89 1. Try to open the file mapping object "Local\SampleMap" by P/Invoking
  90 OpenFileMapping.
  91
  92 2. Map a view of the file mapping into the address space of the current
  93 process by P/Invoking MapViewOfFile.
  94
  95 3. Read a string from the view.
  96
  97 4. Unmap the file view (UnmapViewOfFile) and close the file mapping object
  98 (CloseHandle).
  99
 100
 101 /////////////////////////////////////////////////////////////////////////////
 102 References:
 103
 104 MSDN: Creating Named Shared Memory
 105 http://msdn.microsoft.com/en-us/library/aa366551.aspx
 106
 107
 108 /////////////////////////////////////////////////////////////////////////////